GET api/SIMS/GetClientOutstandingInvoices?clientCodes[0]={clientCodes[0]}&clientCodes[1]={clientCodes[1]}&companyKey={companyKey}
Gets the outstanding invoice(s) for the specified client(s) from the linked SFM company
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientCodes |
A list of client codes (Optional) |
Collection of string |
Required |
| companyKey |
The company name if the service is connected to multiple SIMS companies (Optional) |
string |
Default value is |
Body Parameters
N/A
Response Information
Resource Description
The clients' outstanding invoice(s)
Collection of SfmTransaction| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientCode | string |
N/A |
|
| SystemReference | string |
N/A |
|
| CreditDebit | string |
N/A |
|
| TransactionDate | date |
N/A |
|
| TransactionType | string |
N/A |
|
| InternalReference | string |
N/A |
|
| ExternalReference | string |
N/A |
|
| LocalAmount | decimal number |
N/A |
|
| LocalPaid | decimal number |
N/A |
|
| Reverse | boolean |
N/A |
|
| VatAmount | decimal number |
N/A |
|
| ForeignAmount | decimal number |
N/A |
|
| ForeignVatAmount | decimal number |
N/A |
|
| ForeignPaid | decimal number |
N/A |
|
| AgedBalance | decimal number |
N/A |
|
| Allocated | string |
N/A |
Response Formats
application/json, text/json
Sample:
[
{
"ClientCode": "sample string 1",
"SystemReference": "sample string 2",
"CreditDebit": "sample string 3",
"TransactionDate": "2024-10-06T02:39:04.6778288",
"TransactionType": "sample string 5",
"InternalReference": "sample string 6",
"ExternalReference": "sample string 7",
"LocalAmount": 8.0,
"LocalPaid": 9.0,
"Reverse": true,
"VatAmount": 11.0,
"ForeignAmount": 12.0,
"ForeignVatAmount": 13.0,
"ForeignPaid": 14.0,
"AgedBalance": 15.0,
"Allocated": "sample string 16"
},
{
"ClientCode": "sample string 1",
"SystemReference": "sample string 2",
"CreditDebit": "sample string 3",
"TransactionDate": "2024-10-06T02:39:04.6778288",
"TransactionType": "sample string 5",
"InternalReference": "sample string 6",
"ExternalReference": "sample string 7",
"LocalAmount": 8.0,
"LocalPaid": 9.0,
"Reverse": true,
"VatAmount": 11.0,
"ForeignAmount": 12.0,
"ForeignVatAmount": 13.0,
"ForeignPaid": 14.0,
"AgedBalance": 15.0,
"Allocated": "sample string 16"
}
]